PayPay随時・登録型都度利用承諾 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranPaypayAccept 取引登録（利用承諾）

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
AcceptType	acceptType	半角数字1桁決済タイプ 1：登録型都度パラメータ未指定の場合は随時になります。

URL

/payment/EntryTranPaypayAccept.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "orderID": "ORDER0000001"
}

URL

/payment/EntryTranPaypayAccept.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranPaypayAccept 決済実行（利用承諾）

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
RetURL	retURL	必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。 PayPay画面上でお客様が操作をキャンセルした場合や、利用承諾を実施した場合に指定されたURLにブラウザのリダイレクト経由で結果が送信されます。
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。最大86,400秒（1日）呼出パラメータが空の場合、120秒で処理されます。

URL

/payment/ExecTranPaypayAccept.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive"
}

URL

/payment/ExecTranPaypayAccept.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive

レスポンス

正常

AccessID	accessID	必須半角英数32桁固定取引ID
Token	token	必須半角英数64桁固定トークン取引IDのハッシュ値を返却します。
StartURL	startURL	必須半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。
StartLimitDate	startLimitDate	必須半角数字14桁固定支払開始期限日時支払手続き開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "84636abd0bb03500ffce1e1a78deb1b2",
    "token": "107c44550ac7f47cbc6dbef22c4c27fd62c246b0d9107dc0d6c9b7fddb6004ea",
    "startURL": "https://x01.mul-pay.jp/payment/PaypayStart.idPass",
    "startLimitDate": "20220722112429"
}

レスポンスパラメータ：正常系

AccessID=84636abd0bb03500ffce1e1a78deb1b2&Token=107c44550ac7f47cbc6dbef22c4c27fd62c246b0d9107dc0d6c9b7fddb6004ea&StartURL=https://x01.mul-pay.jp/payment/PaypayStart.idPass&StartLimitDate=20220722112429

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypayAcceptStart 決済開始（利用承諾）

PayPay随時・登録型都度の利用承諾において、お客様をPayPay画面へ遷移させる必要があります。
当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数64桁トークン【決済実行】で発行された値を設定します。

URL

/payment/PaypayAcceptStart.idPass

リクエストパラメータ


				<head>
				  <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
					</head>
				  <body OnLoad='OnLoadEvent();'>
					<form name="PaypayAcceptStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
						<noscript>
							<br>
							<br>
							<div style="text-align:center">
								<h2>PayPayの決済画面へ遷移します。</h2>
								<input type="submit" value="続行">
							</div>
						</noscript>
						<input type="hidden" name="AccessID" value="{AccessID}">
						<input type="hidden" name="Token" value="{Token}">
					</form>
					<script>
				<!--
				function OnLoadEvent() {
				document.PaypayAcceptStartCall.submit();
				}
				//-->
					</script>
				  </body>
				</html>

リダイレクト後、お客様はPayPayログイン画面へ遷移します。

決済結果受信

当サービスは、お客様が利用承諾操作を完了または中止した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果は、お客様に表示しているPayPayの利用承諾同意画面からブラウザ経由で連携されるため、お客様の操作方法によっては操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
Status		必須現状態 REGISTER：利用承諾 PAYFAIL：決済失敗
TranDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
PaypayAcceptCode		半角英数14桁 PayPay承諾番号決済成功時のみ値を設定します。
CheckString		必須半角英数64桁改ざんチェック文字列以下の情報を連結し、SHA256ハッシュした値を返却します。・ショップID ・オーダーID ・現状態・処理日時・PayPay承諾番号・ショップパスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

PaypayAcceptEnd 利用承諾終了

指定したPayPay承諾番号の利用を終了することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PaypayAcceptCode	paypayAcceptCode	必須半角英数14桁 PayPay承諾番号利用を終了するPayPay承諾番号を設定します。

URL

/payment/PaypayAcceptEnd.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "paypayAcceptCode": "51111118068276"
}

URL

/payment/PaypayAcceptEnd.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaypayAcceptCode=51111118068276

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID
Status		status		必須半角英字3桁現状態　END：利用承諾終了

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "END"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=END

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PayType		必須半角数字2桁決済方法 48：PayPay利用承諾

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=48

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 REGISTER：利用承諾 END：利用承諾終了 PAYFAIL：決済失敗
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 REGISTER：利用承諾 END：利用終了
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 48：PayPay（利用承諾）
PayPayAcceptCode		必須半角英数14桁 PayPay承諾番号
ProcessLastDate		必須半角数字14桁固定最終利用日時利用承諾を行った日時、またはPayPay承諾番号を使用して随時・利用承諾決済を行った日時 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=REGISTER&ProcessDate=20191216090000&JobCd=REGISTER&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=48&PayPayAcceptCode=51111118068276&ProcessLastDate=20201124161900

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PayPay